Click or drag to resize

Invite Class

The Invite class represents INVITE method. The INVITE method is used to establish media sessions between clients. Responses to INVITEs are always acknowledged with the ACK method. An INVITE usually has a body containing the media information of the caller. If an INVITE does not contain media information, the ACK contains the media information of the client. A successful INVITE request establishes a dialog between the two clients, which continues until a BYE is sent by either party to end the session.
Inheritance Hierarchy

Namespace:  Independentsoft.Sip.Methods
Assembly:  Independentsoft.Sip (in Independentsoft.Sip.dll) Version: 1.0.700.17927
Syntax
public class Invite : Request

The Invite type exposes the following members.

Constructors
  NameDescription
Public methodInvite
Initializes a new instance of the Invite class.
Public methodInvite(Dialog)
Initializes a new instance of the Invite class from the specified dialog.
Public methodInvite(Response)
Initializes a new instance of the Invite class from the specified response.
Top
Properties
  NameDescription
Public propertyAccept
Gets or sets Accept header field. The Accept header field is used to indicate acceptable message Internet media types in the request body. The header field describes media types using the format type/sub-type commonly used in the Internet. If not present, the assumed acceptable request body format is application/sdp. The wildcard "*" can be used to specify all subtypes.
Public propertyAcceptEncoding
Gets or sets Accept-Encoding header field. The Accept-Encoding header field, is used to specify acceptable request body encoding schemes. If not included, the assumed encoding will be text/plain.
Public propertyAcceptLanguage
Gets or sets Accept-Language header field. The Accept-Language header field, is used in requests to indicate the preferred languages for reason phrases or session descriptions in the request body. The rules for ordering the languages is based on the "q" parameter.
Public propertyAlertInfo
Gets or sets Alert-Info header field. The Alert-Info header field specifies an alternative ring tone.
Public propertyAllow
Gets or sets Allow header field. The Allow header field lists the set of methods supported by the client.
Public propertyAllowEvents
Gets or sets Allow-Events header field. The Allow-Events header field, includes a list of tokens which indicates the event packages supported by the client. In other words, a client sending an Allow-Events header is advertising that it can process and generate requests for all of the event packages listed in that header.
Public propertyBody
Gets or sets the request body.
(Inherited from Request.)
Public propertyBranch
Sets or gets branch parameter in Via header.
(Inherited from Request.)
Public propertyCallID
Gets or sets Call-ID header field. The Call-ID header field is mandatory in all requests. It is used to uniquely identify a call between two clients. If is not set then the SipClient will set this header.
(Inherited from Request.)
Public propertyCallInfo
Gets or sets Call-Info header field. The Call-Info header field provides additional information about the caller.
Public propertyContact
Gets or sets Contact header field. The Contact header field is used to convey a URI that identifies the request originator.
Public propertyContentDisposition
Gets or sets Content-Disposition header field. The Content-Disposition header field is used to describe the function of a request body.
Public propertyContentEncoding
Gets or sets Content-Encoding header field. The Content-Encoding header field is used as a modifier to the "media-type". When present, its value indicates what additional content codings have been applied to the request body, and thus what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type header field.
Public propertyContentLanguage
Gets or sets Content-Language header field. The Content-Language header field is used to indicate the language of a request body. It contains a language tag, which identifies the language.
Public propertyContentLength
Gets o sets Content-Length header field. The Content-Length header field indicates the size of the request body. If no body is present in a request, then the Content-Length header field value must be zero.
(Inherited from Request.)
Public propertyContentType
Gets or sets Content-Type header field. The Content-Type header field is used to specify the Internet media type in the request body. Media types have the familiar form type/sub-type. If this header field is not present, application/sdp is assumed.
(Inherited from Request.)
Public propertyCSeq
Gets CSeq header field. The CSeq header field is a required header field in every request. The CSeq header field contains a number that increases for each request. Usually, it increases by 1 for each new request, with the exception of CANCEL and ACK requests, which use the CSeq number of the INVITE request to which it refers.
(Inherited from Request.)
Public propertyDate
Gets or sets Date header field. The Date header field is used to convey the date when the request is sent.
(Inherited from Request.)
Public propertyErrorInfo
Gets or sets Error-Info header field. The Error-Info header field provides a pointer to additional information about the error status response.
Public propertyExpires
Gets or sets Expires header field. The Expires header field indicates the time interval in which the request is valid. The value of this header field is number of seconds between 0 and 4294967295.
Public propertyFrom
Gets or sets From header field. The From header field is a required header field that indicates the originator of the request.
(Inherited from Request.)
Public propertyHeader
Gets the request header.
(Inherited from Request.)
Public propertyInReplyTo
Gets or sets In-Reply-To header field. The In-Reply-To header field is used to indicate the Call-ID that request references or is returning.
Public propertyJoin
Gets or sets Join header field. The Join header field is used in an INVITE to request that the dialog (session) be joined with an existing dialog (session). The parameters of the Join header field identify the dialog by the Call-ID, To tag, and From tag in a similar way to the Replaces header field. If the Join header field references a point-to-point dialog between two clients, the Join header field is effectively a request to turn the call into a conference call. If the dialog is already part of a conference, the Join header field is a request to be added into the conference.
Public propertyMaxForwards
Gets or sets Max-Forwards header field. The Max-Forwards header field is used to indicate the maximum number of hops that a the request may take. The value of the header field is decremented by each proxy that forwards the request. If is not set then the SipClient will set this header.
(Inherited from Request.)
Public propertyMethod
Gets the request method.
(Inherited from Request.)
Public propertyMinExpires
Gets or sets Min-Expires header field. The Min-Expires header field contains an integer number of seconds that represents the minimum expiration interval that the registrar will accept. The value of this header field is number of seconds between 0 and 4294967295.
Public propertyOrganization
Gets or sets Organization header field. The Organization header field is used to indicate the organization to which the originator of the request belongs.
Public propertyPriority
Gets or sets Priority header field. The Priority header field indicates the urgency of the request as perceived by the client. The Priority header field describes the priority that the SIP request should have to the receiving human or its agent. For example, it may be factored into decisions about call routing and acceptance. For these decisions, a request containing no Priority header field should be treated as if it specified a Priority of "normal". The Priority header field does not influence the use of communications resources such as packet forwarding priority in routers or access to circuits in PSTN gateways. The header field can have the values "non-urgent", "normal", "urgent", and "emergency", but additional values can be defined elsewhere.
Public propertyProxyRequire
Gets or sets Proxy-Require header field. The Proxy-Require header field is used to list features and extensions that a client requires a proxy to support in order to process the request.
Public propertyRecordRoute
Gets or sets Record-Route header field. The Record-Route header field is used to force routing through a proxy for all subsequent requests in a session between two clients.
Public propertyReferredBy
Gets or sets Referred-By header field. The Referred-By header field provides the recipient of a triggered request information that the request was generated as a result of a REFER and the originator of the REFER.
Public propertyReplaces
Gets or sets Replaces header field. The Replaces header field is used in SIP call control applications. A client in an established dialog receiving another INVITE with a Replaces header field that matches the existing dialog must accept the INVITE, terminate the existing dialog with a BYE, and transfer all resources and state from the existing dialog to the newly established dialog.
Public propertyReplyTo
Gets or sets Reply-To header field. The Reply-To header field is used to indicate a URI, which should be used in replying to this request. Normally, this URI is present in the From header field. However, in some cases, the From cannot be populated with this information, so the URI in this header field should be used instead of the From URI.
Public propertyRequire
Gets Require header field. The Require header field is used to tell the client about options that the sender expects the client to support in order to process the request. The Require header field contains a list of option tags. Each option tag defines a SIP extension that must be understood to process the request. Frequently, this is used to indicate that a specific set of extension header fields need to be understood.
Public propertyRoute
Gets Route header field. The Route header field is used to provide routing information for requests.
Public propertyServer
Gets Server header field. The Server header field contains information about the software used by the server to handle the request.
Public propertySessionDescription
Returns the request body as SessionDescription if Content-Type is "application/sdp", otherwise returns null. Sets request body and sets Content-Type as "application/sdp".
(Inherited from Request.)
Public propertySubject
Gets or sets Subject header field. The Subject header field provides a summary or indicates the nature of the call, allowing call filtering without having to parse the session description. The session description does not have to use the same subject indication as the invitation.
Public propertySupported
Gets or sets Supported header field. The Supported header field enumerates all the extensions supported by the client or server.
Public propertyTimestamp
Gets or sets Timestamp header field. The Timestamp header field describes when the client sent the request to the server. The time format is not specified.
Public propertyTo
Gets or sets To header field. The To header field is a required header field in every request used to indicate the recipient of the request.
(Inherited from Request.)
Public propertyUnsupported
Gets Unsupported header field. The Unsupported header field lists the features not supported by the server.
Public propertyUri
Gets or sets request URI. It indicates the user or service to which this request is being addressed.
(Inherited from Request.)
Public propertyVia
Gets or sets Via header field. The Via header field indicates the path taken by the request so far and indicates the path that should be followed in routing responses. The "branch" parameter in the Via header field values serves as a transaction identifier, and is used by proxies to detect loops. The Via header field value contains the transport protocol used to send the message, the client's host name or network address, and possibly the port number at which it wishes to receive responses. The Via header field value can also contain parameters such as "maddr", "ttl", "received" and "branch".
(Inherited from Request.)
Public propertyWarning
Gets Warning header field. The Warning header field is used to carry additional information about the status of a request or response. The warning text should be in a natural language that is most likely to be intelligible to the human user receiving the response.
Top
Methods
  NameDescription
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodToString
Converts the value of this instance to its equivalent string representation.
(Inherited from Request.)
Top
See Also